SftTree/NET 2.0

NavigateLeft Method, SftTree Class

Softel vdm, Inc.

Navigates left one item or cell from the specified item or cell.

Syntax      SftTree Class (Softelvdm.SftTreeNET)

VB   

Public Function NavigateLeft( _
     ByVal StartObject As Object, _
     ByVal fCollapse As Boolean, _
     ByVal fSelect As Boolean, _
     ByVal fSelectCumulative As Boolean _
  ) As Object

C#   

public object NavigateLeft(
     object StartObject,
     bool fCollapse,
     bool fSelect,
     bool fSelectCumulative );

C++   

public: Object^ NavigateLeft(
     Object^ StartObject,
     bool fCollapse,
     bool fSelect,
     bool fSelectCumulative );

fCollapse

Defines whether the item is collapsed if the starting item or cell is an item which can be collapsed. True to collapse the item, otherwise False. If an item is collapsed, the returned item or cell is identical to the start object (StartObject).

fSelect

Defines whether the item or cell found is automatically selected, True to select, otherwise False.

fSelectCumulative

Defines whether the selection is cumulative. True if the selection is cumulative, otherwise False. This parameter is ignored if fSelect is False and can only be used with when multiple item or multiple cell selection is active (SelectionStyle).

StartObject

Defines the starting item (ItemClass) or cell (CellClass). If null/Nothing is specified, the focus object (FocusObject) is the starting item or cell.

Return Value

The item or cell.

Comments

The NavigateLeft method navigates left one item or cell from the specified item or cell.

Given a starting item or cell, this method returns the next item or cell in that direction that can be selected. It considers cell merging and the selectable area (SelectableArea).

If fSelect is True to automatically select the new item or cell, the specified StartObject, an item or cell, must match the current selection style (SelectionStyle).

If the StartObject parameter is null/Nothing and the FocusObject property is null/Nothing, the method returns null/Nothing.


Feedback / comments / error reports for this topic
© 2007 - Softel vdm, Inc. - www.softelvdm.com